<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSocket: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="prev" href="GtkPlug.html" title="GtkPlug">
<link rel="next" href="RecentDocuments.html" title="Recently Used Documents">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkSocket.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkSocket.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkSocket.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkSocket.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="PlugSocket.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkPlug.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RecentDocuments.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSocket"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSocket.top_of_page"></a>GtkSocket</span></h2>
<p>GtkSocket — Container for widgets from other processes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSocket.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSocket.html#gtk-socket-new" title="gtk_socket_new ()">gtk_socket_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()">gtk_socket_add_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Window</span>
</td>
<td class="function_name">
<a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()">gtk_socket_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkWindow</span> *
</td>
<td class="function_name">
<a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()">gtk_socket_get_plug_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSocket.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkSocket.html#GtkSocket-plug-added" title="The “plug-added” signal">plug-added</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="GtkSocket.html#GtkSocket-plug-removed" title="The “plug-removed” signal">plug-removed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSocket.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkSocket.html#GtkSocket-struct" title="struct GtkSocket">GtkSocket</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSocket.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
            <span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
                <span class="lineart">╰──</span> GtkSocket
</pre>
</div>
<div class="refsect1">
<a name="GtkSocket.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSocket implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSocket.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtkx.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkSocket.description"></a><h2>Description</h2>
<p>Together with <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> provides the ability to embed
widgets from one process into another process in a fashion that
is transparent to the user. One process creates a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget
and passes that widget’s window ID to the other process, which then
creates a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with that window ID. Any widgets contained in the
<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> then will appear inside the first application’s window.</p>
<p>The socket’s window ID is obtained by using <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()"><code class="function">gtk_socket_get_id()</code></a>.
Before using this function, the socket must have been realized,
and for hence, have been added to its parent.</p>
<div class="refsect3">
<a name="id-1.3.21.3.9.4"></a><h4>Obtaining the window ID of a socket.</h4>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="n">GtkWidget</span> <span class="o">*</span><span class="n">socket</span> <span class="o">=</span> <span class="n">gtk_socket_new</span> <span class="p">();</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">socket</span><span class="p">);</span>
<span class="n">gtk_container_add</span> <span class="p">(</span><span class="n">GTK_CONTAINER</span> <span class="p">(</span><span class="n">parent</span><span class="p">),</span> <span class="n">socket</span><span class="p">);</span>

<span class="c1">// The following call is only necessary if one of</span>
<span class="c1">// the ancestors of the socket is not yet visible.</span>
<span class="n">gtk_widget_realize</span> <span class="p">(</span><span class="n">socket</span><span class="p">);</span>
<span class="n">g_print</span> <span class="p">(</span><span class="s">&quot;The ID of the sockets window is %#x</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span>
         <span class="n">gtk_socket_get_id</span> <span class="p">(</span><span class="n">socket</span><span class="p">));</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>Note that if you pass the window ID of the socket to another
process that will create a plug in the socket, you must make
sure that the socket widget is not destroyed until that plug
is created. Violating this rule will cause unpredictable
consequences, the most likely consequence being that the plug
will appear as a separate toplevel window. You can check if
the plug has been created by using <a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()"><code class="function">gtk_socket_get_plug_window()</code></a>.
If it returns a non-<code class="literal">NULL</code> value, then the plug has been
successfully created inside of the socket.</p>
<p>When GTK+ is notified that the embedded window has been destroyed,
then it will destroy the socket as well. You should always,
therefore, be prepared for your sockets to be destroyed at any
time when the main event loop is running. To prevent this from
happening, you can connect to the <a class="link" href="GtkSocket.html#GtkSocket-plug-removed" title="The “plug-removed” signal"><span class="type">“plug-removed”</span></a> signal.</p>
<p>The communication between a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> and a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> follows the
<a class="ulink" href="http://www.freedesktop.org/Standards/xembed-spec" target="_top">XEmbed Protocol</a>.
This protocol has also been implemented in other toolkits, e.g. Qt,
allowing the same level of integration when embedding a Qt widget
in GTK or vice versa.</p>
<p>The <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widgets are only available when GTK+
is compiled for the X11 platform and <code class="literal">GDK_WINDOWING_X11</code> is defined.
They can only be used on a <span class="type">GdkX11Display</span>. To use <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and
<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, you need to include the <code class="literal">gtk/gtkx.h</code> header.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSocket.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-socket-new"></a><h3>gtk_socket_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_socket_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new empty <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p>
<div class="refsect3">
<a name="gtk-socket-new.returns"></a><h4>Returns</h4>
<p>  the new <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-add-id"></a><h3>gtk_socket_add_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_socket_add_id (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
                   <em class="parameter"><code><span class="type">Window</span> window</code></em>);</pre>
<p>Adds an XEMBED client, such as a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, to the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.  The
client may be in the same process or in a different process. </p>
<p>To embed a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> in a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, you can either create the
<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with <code class="literal">gtk_plug_new (0)</code>, call 
<a class="link" href="GtkPlug.html#gtk-plug-get-id" title="gtk_plug_get_id ()"><code class="function">gtk_plug_get_id()</code></a> to get the window ID of the plug, and then pass that to the
<a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>, or you can call <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()"><code class="function">gtk_socket_get_id()</code></a> to get the
window ID for the socket, and call <a class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()"><code class="function">gtk_plug_new()</code></a> passing in that
ID.</p>
<p>The <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window
 before you can make this call.</p>
<div class="refsect3">
<a name="gtk-socket-add-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>socket_</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>the Window of a client participating in the XEMBED protocol.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-get-id"></a><h3>gtk_socket_get_id ()</h3>
<pre class="programlisting"><span class="returnvalue">Window</span>
gtk_socket_get_id (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
<p>Gets the window ID of a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, which can then
be used to create a client embedded inside the socket, for
instance with <a class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()"><code class="function">gtk_plug_new()</code></a>. </p>
<p>The <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window 
before you can make this call.</p>
<div class="refsect3">
<a name="gtk-socket-get-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>socket_</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-socket-get-id.returns"></a><h4>Returns</h4>
<p> the window ID for the socket</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-get-plug-window"></a><h3>gtk_socket_get_plug_window ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> *
gtk_socket_get_plug_window (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
<p>Retrieves the window of the plug. Use this to check if the plug has
been created inside of the socket.</p>
<div class="refsect3">
<a name="gtk-socket-get-plug-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>socket_</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-socket-get-plug-window.returns"></a><h4>Returns</h4>
<p>the window of the plug if
available, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 2.14</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSocket.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSocket-struct"></a><h3>struct GtkSocket</h3>
<pre class="programlisting">struct GtkSocket;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSocket.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkSocket-plug-added"></a><h3>The <code class="literal">“plug-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_,
               <span class="type">gpointer</span>   user_data)</pre>
<p>This signal is emitted when a client is successfully
added to the socket.</p>
<div class="refsect3">
<a name="GtkSocket-plug-added.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>socket_</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSocket-plug-removed"></a><h3>The <code class="literal">“plug-removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_,
               <span class="type">gpointer</span>   user_data)</pre>
<p>This signal is emitted when a client is removed from the socket.

The default action is to destroy the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, so if you

want to reuse it you must add a signal handler that returns <code class="literal">TRUE</code>.</p>
<div class="refsect3">
<a name="GtkSocket-plug-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>socket_</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GtkSocket-plug-removed.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> to stop other handlers from being invoked.</p>
</div>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSocket.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, <a class="ulink" href="http://www.freedesktop.org/Standards/xembed-spec" target="_top">XEmbed Protocol</a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>